Documentation

API Documentation

Table of Contents

Classes

imonit_client

Constants

checktoken  = \listener . '/checktoken.php'
URL for the verifytoken service
count  = \listener . 'count.php'
URL for the count microservice service.
detailliert  = 'detailliert'
diese Konstante definiert den Darstellungsgrad für bestimmte Meldungen die mit der Funktion debug gemacht werden.
end  = \listener . 'end.php'
URL for the end service.
endpage  = \listener . '/endpage.php'
URL for the endpage service.
imonit_client_lib_Version  = "00.02.065 06.04.2026"
Enthält die Version und das letzte Änderungsdatum dieser Bibliothek.
imonit_server  = 'server.i-mon-it.de'
indev  = \true
itoken  = 'token'
This is the name of the session variable holding information about the token number used on the website to be monitored.
itokenfilename  = 'imonit.token'
Name of the local file holding the token information.This file has to be placed in the root directory of your webapplication and one each for each webapplication. Those files are personalized fao our account and the webapplivcation you are monitoring with i-mon-it.
lastentry  = \listener . 'lastentry.php'
listener  = 'http://' . \imonit_server . '/'
local_server  = '.i-mon-it.local'
mid  = \listener . 'mid.php'
URL for the mid service.
midpage  = \listener . '/midpage.php'
URL for the midpage service.
ping  = \listener . 'ping.php'
start  = \listener . 'start.php'
startpage  = \listener . 'startpage.php'
tokenok  = 'token is ok'
ua  = \listener . 'UA.php'

Functions

re()  : bool
diese Funktion überprüft ob der übergebene Schlüssel in der request Variable gesetzt ist.
req()  : string
Diese Funktion gibt den Wert der Variable_REQUEST zurück, sofern der übergebene Schlüssel vorhanden ist.
uanr()  : int
debuglevel()  : int
Diese Funktion übersetzt die Stringkonstanten für die Fehlerlevel in ganzzahligen Werte, welche dann verglichen werden können, um zu entscheiden ob eine Fehlermeldung angezeigt wird oder nicht.
debug_show()  : bool
Liefert basierend auf dem übergebenen Fehlerlevel einen logischen Wert, welche anzeigt ob eine Fehlermeldung angezeigt werden soll, oder nicht.
debug()  : bool
Diese Funktion ermöglicht eine simple und standardisierte Darstellung von Meldungen zum Zwecke der Fehlersuche und während der Entwicklungszeit.
getGender()  : string
Übersetzt ein einzelenes in der Datenbank verwendetes Zeichen in Gender in eine Anrede
imonit_client_lib_version()  : string
janeintobool()  : bool
rec_check()  : bool
MitHilfe dieser Funktion kann überprüft werdenkann, ob die Gefahr einer endlosen Rekursion besteht. Die Funktion gibt zurück, ob die Anzahl der Rekursionsschleifen einen bestimmten Wert erreicht hat oder übersteigt, in diesem Fall wird der Wert true zurückgegeben, sodass das Überprüfen der Programmodul gegebenenfalls abbrechen kann und somit die Rekursionsschleife unterbrochen wird. Standardmäßig wird bei einer Rekursionstiefe von zehn abgebrochen.
janein()  : string
Gibt die Zeichenketten Ja oder nein zurück
standardize()  : string
getuseragent()  : string
This function identifies the user agent used by the clients website.

Constants

detailliert

diese Konstante definiert den Darstellungsgrad für bestimmte Meldungen die mit der Funktion debug gemacht werden.

public string detailliert = 'detailliert'

Dies ist ein Wert für den Darstellungslevel in der Funktion Debug

Tags
see
debug()

endpage

URL for the endpage service.

public string endpage = \listener . '/endpage.php'

URL for the endpage service

Tags
see
imonit_client::endpage()

imonit_client_lib_Version

Enthält die Version und das letzte Änderungsdatum dieser Bibliothek.

public string imonit_client_lib_Version = "00.02.065 06.04.2026"

Version und Änderungsdatum der Bibliothek.

imonit_server

public mixed imonit_server = 'server.i-mon-it.de'

itoken

This is the name of the session variable holding information about the token number used on the website to be monitored.

public mixed itoken = 'token'

you

itokenfilename

Name of the local file holding the token information.This file has to be placed in the root directory of your webapplication and one each for each webapplication. Those files are personalized fao our account and the webapplivcation you are monitoring with i-mon-it.

public string itokenfilename = 'imonit.token'

Name of the tokenfile holding the correct information.

lastentry

public mixed lastentry = \listener . 'lastentry.php'

listener

public mixed listener = 'http://' . \imonit_server . '/'

midpage

URL for the midpage service.

public string midpage = \listener . '/midpage.php'

URL for the endpage service

Tags
see
imonit_client::endpage()

startpage

public mixed startpage = \listener . 'startpage.php'

Functions

re()

diese Funktion überprüft ob der übergebene Schlüssel in der request Variable gesetzt ist.

re(string $key) : bool
Parameters
$key : string

Name des gesuchten Schlüssels.

Tags
see
req()
Return values
bool —

Sofern der Schlüssel in der request Variablen vorhandenes wird true zurückgegeben. Andernfalls wird false zurückgegeben.

req()

Diese Funktion gibt den Wert der Variable_REQUEST zurück, sofern der übergebene Schlüssel vorhanden ist.

req(string $key[, string $default = '' ]) : string

Sollte der Schlüssel aktuell nicht vorhanden sein, dann wird eine leere Zeichenkette zurückgegeben.

Parameters
$key : string

Nach diesen Schlüssel wird in der request Variable gesucht

  •       * @param string $default, dies ist der Defaultwert der zurückgegeben wird, wenn der Schlüssel nicht gefunden wurde.
$default : string = ''
Tags
see
re()
Return values
string —

Wert der request Variable sofern sie existiert.

uanr()

uanr(string $useragent) : int
Parameters
$useragent : string
Return values
int

debuglevel()

Diese Funktion übersetzt die Stringkonstanten für die Fehlerlevel in ganzzahligen Werte, welche dann verglichen werden können, um zu entscheiden ob eine Fehlermeldung angezeigt wird oder nicht.

debuglevel([string $debuglevel = defaultdebug ]) : int
Parameters
$debuglevel : string = defaultdebug

Enthält als Stringden gewünschten Level in dem die Meldung angezeigt werden soll. Der unzureichende Fehlerlevel

Return values
int —

der ganzzahligen Wert des übergebenen Fehler levels

debug_show()

Liefert basierend auf dem übergebenen Fehlerlevel einen logischen Wert, welche anzeigt ob eine Fehlermeldung angezeigt werden soll, oder nicht.

debug_show([string $level = defaultdebug ]) : bool
Parameters
$level : string = defaultdebug

Text des Fehler levels der mit dem eingestellten Standard Fehlerlevel verglichen werden muss.

Tags
see
debuglevel()
Return values
bool

debug()

Diese Funktion ermöglicht eine simple und standardisierte Darstellung von Meldungen zum Zwecke der Fehlersuche und während der Entwicklungszeit.

debug([string $level = defaultdebug ][, string $msg = '' ]) : bool
Parameters
$level : string = defaultdebug

Name des levels, welchen diese Meldung nach Meinung des Programmierers hat.

$msg : string = ''

Anzuzeigende Meldung.

Return values
bool —

Die Funktion gibt zurück, ob die Meldung im aktuellen Kontext angezeigt wurde oder nicht. Eine Nutzung und Verarbeitung ist optional. In der bisherigen Programmierpraxis wird dies nicht verwendet.

getGender()

Übersetzt ein einzelenes in der Datenbank verwendetes Zeichen in Gender in eine Anrede

getGender(string $Gender) : string
Parameters
$Gender : string

"u","w",'d'

Return values
string —

"Herr, "Frau', "Guten Tag",""

imonit_client_lib_version()

imonit_client_lib_version() : string
Return values
string

janeintobool()

janeintobool(string $input) : bool
Parameters
$input : string
Return values
bool

rec_check()

MitHilfe dieser Funktion kann überprüft werdenkann, ob die Gefahr einer endlosen Rekursion besteht. Die Funktion gibt zurück, ob die Anzahl der Rekursionsschleifen einen bestimmten Wert erreicht hat oder übersteigt, in diesem Fall wird der Wert true zurückgegeben, sodass das Überprüfen der Programmodul gegebenenfalls abbrechen kann und somit die Rekursionsschleife unterbrochen wird. Standardmäßig wird bei einer Rekursionstiefe von zehn abgebrochen.

rec_check([int $depth = 10 ]) : bool
Parameters
$depth : int = 10

Optionaler Parameter, der die geduldete Rekursionstiefe darstellt. Der Standardwert liegt bei einer Tiefe von zehn

Return values
bool —

gibt zurück ob die maximale Regionstiefe erreicht worden ist (Rückgabewert:true) oder eben nicht (Rückgabewert:false).

janein()

Gibt die Zeichenketten Ja oder nein zurück

janein(bool $value) : string
Parameters
$value : bool
Return values
string —

Ja oder Nein je nach Parameter

standardize()

standardize(string $methodorfile) : string
Parameters
$methodorfile : string
Return values
string

getuseragent()

This function identifies the user agent used by the clients website.

getuseragent() : string
Return values
string —

Name of the user agent. In case it cannot be determined the function will return'unknown'.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results